<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>dp14: XDp Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">dp14
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_dp.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XDp Struct Reference<div class="ingroups"><a class="el" href="group__dp.html">Overview</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>The <a class="el" href="struct_x_dp.html" title="The XDp instance data. ">XDp</a> instance data.  
 <a href="struct_x_dp.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aa45ebd510e1e83bc9ebdcd1178b33290"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_dp___config.html">XDp_Config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dp.html#aa45ebd510e1e83bc9ebdcd1178b33290">Config</a></td></tr>
<tr class="memdesc:aa45ebd510e1e83bc9ebdcd1178b33290"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configuration structure for the DisplayPort TX core.  <a href="#aa45ebd510e1e83bc9ebdcd1178b33290">More...</a><br/></td></tr>
<tr class="separator:aa45ebd510e1e83bc9ebdcd1178b33290"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd280866d275718d5ee5345d91f3770e"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dp.html#acd280866d275718d5ee5345d91f3770e">IsReady</a></td></tr>
<tr class="memdesc:acd280866d275718d5ee5345d91f3770e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device is initialized and ready.  <a href="#acd280866d275718d5ee5345d91f3770e">More...</a><br/></td></tr>
<tr class="separator:acd280866d275718d5ee5345d91f3770e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f370fbb0ce48221b04b4f558a84a982"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dp.html#ga0ca611069a383f672c9d2fe3574ffd4f">XDp_TimerHandler</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dp.html#a5f370fbb0ce48221b04b4f558a84a982">UserTimerWaitUs</a></td></tr>
<tr class="memdesc:a5f370fbb0ce48221b04b4f558a84a982"><td class="mdescLeft">&#160;</td><td class="mdescRight">Custom user function for delay/sleep.  <a href="#a5f370fbb0ce48221b04b4f558a84a982">More...</a><br/></td></tr>
<tr class="separator:a5f370fbb0ce48221b04b4f558a84a982"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeac9ef9a7568a32e53007f53e782c63a"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dp.html#aeac9ef9a7568a32e53007f53e782c63a">UserTimerPtr</a></td></tr>
<tr class="memdesc:aeac9ef9a7568a32e53007f53e782c63a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to a timer instance used by the custom user delay/sleep function.  <a href="#aeac9ef9a7568a32e53007f53e782c63a">More...</a><br/></td></tr>
<tr class="separator:aeac9ef9a7568a32e53007f53e782c63a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="struct_x_dp.html" title="The XDp instance data. ">XDp</a> instance data. </p>
<p>The user is required to allocate a variable of this type for every <a class="el" href="struct_x_dp.html" title="The XDp instance data. ">XDp</a> device in the system. A pointer to a variable of this type is then passed to the driver API functions. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="aa45ebd510e1e83bc9ebdcd1178b33290"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_dp___config.html">XDp_Config</a> XDp::Config</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Configuration structure for the DisplayPort TX core. </p>

<p>Referenced by <a class="el" href="xdp__tx__mst__example_8c.html#a02657a34bba30ff571b25e0b8992f081">Dptx_MstExampleRun()</a>, <a class="el" href="xdp__tx__example__common_8h.html#a6700facd123226784319febf7189c092">Dptx_StartLink()</a>, <a class="el" href="group__dp.html#ga99e89fe4b5550c32cef410fffab99318">XDp_CfgInitialize()</a>, <a class="el" href="group__dp.html#gaa1d4f025616d218cff6dc47ca3456ff4">XDp_IsLaneCountValid()</a>, and <a class="el" href="group__dp.html#ga57017c66cf4d3bcf72d257368119e008">XDp_IsLinkRateValid()</a>.</p>

</div>
</div>
<a class="anchor" id="acd280866d275718d5ee5345d91f3770e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDp::IsReady</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device is initialized and ready. </p>

<p>Referenced by <a class="el" href="group__dp.html#ga99e89fe4b5550c32cef410fffab99318">XDp_CfgInitialize()</a>, <a class="el" href="group__dp.html#ga85f185599e63935fa41e46ca249d4a3a">XDp_Initialize()</a>, <a class="el" href="group__dp.html#ga5d95fcd5fa78f5ad7ac1bbfc112ea5f3">XDp_InterruptHandler()</a>, <a class="el" href="group__dp.html#ga506720dc403caa084533c26e52ae464b">XDp_SelfTest()</a>, and <a class="el" href="group__dp.html#ga82deff65c3a8f1a090bcda332df3a7ee">XDp_WaitUs()</a>.</p>

</div>
</div>
<a class="anchor" id="aeac9ef9a7568a32e53007f53e782c63a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* XDp::UserTimerPtr</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pointer to a timer instance used by the custom user delay/sleep function. </p>

<p>Referenced by <a class="el" href="group__dp.html#ga7e31cad17809d5e67bade4c08a4b6c93">XDp_SetUserTimerHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="a5f370fbb0ce48221b04b4f558a84a982"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__dp.html#ga0ca611069a383f672c9d2fe3574ffd4f">XDp_TimerHandler</a> XDp::UserTimerWaitUs</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Custom user function for delay/sleep. </p>

<p>Referenced by <a class="el" href="group__dp.html#ga7e31cad17809d5e67bade4c08a4b6c93">XDp_SetUserTimerHandler()</a>, and <a class="el" href="group__dp.html#ga82deff65c3a8f1a090bcda332df3a7ee">XDp_WaitUs()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
